<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>テンプレート関数プラグイン</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="index.html" title="Smarty マニュアル">
<link rel="up" href="plugins.html" title="Chapter 16. プラグインによる Smarty の拡張">
<link rel="prev" href="plugins.writing.html" title="プラグインの記述">
<link rel="next" href="plugins.modifiers.html" title="修飾子プラグイン">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr><th colspan="3" align="center">テンプレート関数プラグイン</th></tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="plugins.writing.html">Prev</a> </td>
<th width="60%" align="center">Chapter 16. プラグインによる Smarty の拡張</th>
<td width="20%" align="right"> <a accesskey="n" href="plugins.modifiers.html">Next</a>
</td>
</tr>
</table>
<hr>
</div>
<div class="sect1" title="テンプレート関数プラグイン">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="plugins.functions"></a>テンプレート関数プラグイン</h2></div></div></div>
<div class="funcsynopsis">
<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef">void <b class="fsfunc">smarty_function_name</b>(</code></td>
<td>
<var class="pdparam">$params</var>, </td>
<td> </td>
</tr>
<tr>
<td> </td>
<td>
<var class="pdparam">&amp;$smarty</var><code>)</code>;</td>
<td> </td>
</tr>
</table>
<div class="paramdef-list">
<code>array <var class="pdparam">$params</var></code>;<br><code>object <var class="pdparam">&amp;$smarty</var></code>;</div>
<div class="funcprototype-spacer"> </div>
</div>
<p>
     テンプレートからテンプレート関数に渡された全ての
     <a class="link" href="language.syntax.attributes.html" title="属性">属性</a> は、
     連想配列として <em class="parameter"><code>$params</code></em> に格納されます。
    </p>
<p>
     関数の出力（戻り値）はテンプレート関数のタグの部分と置き換えられます(例:
     <a class="link" href="language.function.fetch.html" title="{fetch}"><code class="varname">{fetch}</code></a>
     関数)。 あるいは何も出力せずに単に他のタスクを実行する事ができます(例:
     <a class="link" href="language.custom.functions.html#language.function.assign" title="{assign}">
     <code class="varname">{assign}</code></a> 関数)。
    </p>
<p>
     関数によっていくつかの変数をテンプレートに割り当てる必要がある、
     もしくは Smarty に提供された他の機能を使う必要がある場合は、
     提供された <em class="parameter"><code>$smarty</code></em> オブジェクトを使用して
     <code class="literal">$smarty-&gt;foo()</code> のようにします。
    </p>
<p>
     </p>
<div class="example">
<a name="id2860444"></a><p class="title"><b>Example 16.1. 出力ありのテンプレート関数プラグイン</b></p>
<div class="example-contents"><pre class="programlisting">

&lt;?php
/*
 * Smarty plugin
 * -------------------------------------------------------------
 * File:     function.eightball.php
 * Type:     function
 * Name:     eightball
 * Purpose:  ランダムに回答を出力する
 * -------------------------------------------------------------
 */
function smarty_function_eightball($params, &amp;$smarty)
{
    $answers = array('はい',
                     'いいえ',
                     'わかりません',
                     '可能性は低い',
                     '今は答えられません',
                     '実はもう実現しているのかも……');

    $result = array_rand($answers);
    return $answers[$result];
}
?&gt;

</pre></div>
</div>
<p><br class="example-break">
    </p>
<p>
     次のようにテンプレートで使用する事ができます。
    </p>
<pre class="programlisting">
質問: 将来、タイムトラベルは実現可能でしょうか?
答え: {eightball}.
    </pre>
<p>
     </p>
<div class="example">
<a name="id2860502"></a><p class="title"><b>Example 16.2. 出力なしのテンプレート関数プラグイン</b></p>
<div class="example-contents"><pre class="programlisting">

&lt;?php
/*
 * Smarty plugin
 * -------------------------------------------------------------
 * File:     function.assign.php
 * Type:     function
 * Name:     assign
 * Purpose:  テンプート変数に値を割り当てる
 * -------------------------------------------------------------
 */
function smarty_function_assign($params, &amp;$smarty)
{
    if (empty($params['var'])) {
        $smarty-&gt;trigger_error("assign: パラメータ 'var' がありません");
        return;
    }

    if (!in_array('value', array_keys($params))) {
        $smarty-&gt;trigger_error("assign: パラメータ 'value' がありません");
        return;
    }

    $smarty-&gt;assign($params['var'], $params['value']);
}
?&gt;

      </pre></div>
</div>
<p><br class="example-break">
    </p>
<p>
     <a class="link" href="api.register.function.html" title="register_function()"><code class="varname">register_function()</code></a>
     および
     <a class="link" href="api.unregister.function.html" title="unregister_function"><code class="varname">unregister_function()</code></a>
     も参照してください。
    </p>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="plugins.writing.html">Prev</a> </td>
<td width="20%" align="center"><a accesskey="u" href="plugins.html">Up</a></td>
<td width="40%" align="right"> <a accesskey="n" href="plugins.modifiers.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">プラグインの記述 </td>
<td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td>
<td width="40%" align="right" valign="top"> 修飾子プラグイン</td>
</tr>
</table>
</div>
</body>
</html>
